<!doctype html>
<html lang="en">

<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  
  <meta name="generator" content="Hugo 0.98.0" />

  
  <meta name="description" content="走在通往幸福的路上">
  

  
  <link rel="apple-touch-icon" sizes="180x180" href="https://blog.v5u.win/apple-touch-icon.png">

  
  <link rel="icon" type="image/png" sizes="32x32" href="https://blog.v5u.win/favicon-32x32.png">

  
  <link rel="icon" type="image/png" sizes="16x16" href="https://blog.v5u.win/favicon-16x16.png">

  
  <link rel="manifest" href="https://blog.v5u.win/site.webmanifest">

  
  <link rel="mask-icon" href="https://blog.v5u.win/safari-pinned-tab.svg" color="">

  <meta name="msapplication-TileColor" content="">

  <meta name="theme-color" content="">

  
  <link rel="stylesheet" href="https://blog.v5u.win/css/bootstrap.min.css" />

  
  <title>Xcode注释 | 为吾优</title>
  

  <style>
body {
  min-width: 300px;
}

.custom-navbar {
  margin-bottom: 1em;
  height: 60px;
}

.custom-navbar a {
  display: inline-block; 
  padding: 18px 0;
  margin-right: 1em; 
  font-weight: bold; 
}

.custom-navbar a:hover,
.custom-navbar a:focus {
  text-decoration: none; 
}

@media print {
  .custom-navbar {
    display: none;
  }
}

article {
  padding-bottom: 1em;
}

img {
  max-width: 100%;
}


body {
  background-color: #fff;
}



body {
  color: #212529;
}



a {
  color: #007bff;
}



a:hover,
a:focus {
  color: #0056b3;
}



.custom-navbar {
  background-color: #212529;
}



.custom-navbar a {
  color: rgba(255,255,255,.75);
}



.custom-navbar a:hover,
.custom-navbar a:focus {
  color: rgba(255,255,255,1);
}



.container {
  max-width: 800px;
}





</style>
</head>

<body>
  <nav class="custom-navbar">
  <div class="container">
    
    <a href="/">文章</a>
    
    <a href="/tags/">标签</a>
    
    <a href="/about/">关于</a>
    
    <a href="/index.xml">RSS</a>
    
  </div>
</nav>
  
  <div class="container">
    <article>
      <h1>Xcode注释</h1>
<p>
  <small class="text-secondary">
  
  
  2016-03-02
  </small>
  
</p>
<h2 id="xcode注释">Xcode注释</h2>
<p>类与协议</p>
<pre><code>/** 文档B.
 *
 * 文档B的详细描述.
 */
@interface DocB : NSObject
/// 文档A.
@interface DocA : NSObject
</code></pre>
<p>文本链接</p>
<pre><code>/**
 * - [文档B](DocB) : 类的链接文本.（仅appledoc）
 */
</code></pre>
<p>单行注释</p>
<pre><code>///# 标题1
///## 标题2
///hello oc，下面的空行是为了换行
///
///hello swift
/// - 这里使用了无序列表
/// - 使用加粗 **this**， 使用斜体 _this_
/// - 添加一个链接: [百度](http://www.baidu.com)
/// - 添加一个图片:![swift picture](http://img0.imgtn.bdimg.com/it/u=14209024,814391630&amp;fm=21&amp;gp=0.jpg )
</code></pre>
<p>多行注释文档</p>
<pre><code>/**
    多行注释文档相比于普通多行注释多了一个星号。
    在这里可以使用markDown语法，书写各种提示信息
    如：显示一个有序列表
    1. 有序列表
    2. 有序列表
    3. 有序列表
*/
</code></pre>
<p>方法/函数的注释</p>
<p>方法的注释包括传入参数、返回值、和异常等说明</p>
<pre><code>/**
 初始化 数据和颜色值
 @param frame      frame
 @param dataItems  数据集
 @param colorItems 色值集
 @return self
 */
 - (id)initWithFrame:(CGRect)frame dataItems:(NSArray*)dataItems colorItems:(NSArray*)colorItems;
</code></pre>
<h4 id="在所有的编程环境中-有几种通用的注释方式我们默认遵守他们的规则">在所有的编程环境中 有几种通用的注释方式我们默认遵守他们的规则</h4>
<p>它们是：TODO, FIXME, XXX, ??? , !!!</p>
<ul>
<li>它们分别代表什么意思？</li>
</ul>
<blockquote>
<p>TODO: + 说明：</p>
</blockquote>
<blockquote>
<p>说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。</p>
</blockquote>
<blockquote>
<p>对那些临时的, 短期的解决方案, 或已经够好但仍不完美的代码使用 TODO 注释.</p>
</blockquote>
<blockquote>
<p>FIXME: + 说明：</p>
</blockquote>
<blockquote>
<p>说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。</p>
</blockquote>
<blockquote>
<p>XXX: + 说明：</p>
</blockquote>
<blockquote>
<p>说明标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明。</p>
</blockquote>
<ul>
<li>
<p>关于用法</p>
<p>TODO 注释要使用全大写的字符串 TODO, 在随后的圆括号里写上你的大名, 邮件地址, 或其它身份标识. 冒号是可选的. 主要目的是让添加注释的人 (也是可以请求提供更多细节的人) 可根据规范的 TODO 格式进行查找. 添加 TODO 注释并不意味着你要自己来修正.</p>
</li>
</ul>
<p>// TODO(<a href="mailto:kl@gmail.com">kl@gmail.com</a>): Use a “*” here for concatenation operator.</p>
<p>// TODO(Zeke) change this to use relations.</p>
<p>如果加 TODO 是为了在 “将来某一天做某事”, 可以附上一个非常明确的时间 “Fix by November 2005”), 或者一个明确的事项 (“Remove this code when all clients can handle XML responses.”).</p>
<ul>
<li>如何让Xcode识别这些注释，以便于我们更好的查看？</li>
</ul>
<ol>
<li>TARGETS–&gt;(项目名称)–&gt;Build Phases–&gt;选择左上角”+”符号，添加”New Run Script Phase“</li>
<li>在脚本框中添加</li>
</ol>
<pre><code>KEYWORDS=”TODO:|FIXME:|???:|!!!:”

find “${SRCROOT}” &amp;#40; -name “.h” -or -name “.m” &amp;#41; -print0 | xargs -0 egrep –with-filename –line-number –only-matching “($KEYWORDS).*$&amp;#8221; | perl -p -e &amp;#8220;s/($KEYWORDS)/ warning: $1/”
</code></pre>
<ol start="3">
<li>每次编译Xcode时，在Xcode左侧的”show the issue navigator”面板中就能看到你的注释信息</li>
</ol>

    </article>
  </div>

  
  
  

  
</body>

</html>